package be.nepherte.movmanager.client.ui.components;

import be.nepherte.movmanager.client.exceptions.InvalidMovieException;
import be.nepherte.movmanager.domain.Movie;

/**
 * Every class implementing this interface declares that it contains a movie.
 * This movie can be retrieved and replaced.
 * 
 * <p>
 * Copyright © 2010 Bart Verhoeven
 * </p>
 * 
 * <p>
 * This file is part of MovManager.
 * </p>
 * 
 * <p>
 * MovManager is free software: you can redistribute it and/or modify it under
 * the terms of the GNU General Public License as published by the Free Software
 * Foundation, either version 3 of the License, or (at your option) any later
 * version.
 * </p>
 * <p>
 * MovManager is distributed in the hope that it will be useful, but WITHOUT ANY
 * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
 * A PARTICULAR PURPOSE. See the GNU General Public License for more details.
 * </p>
 * <p>
 * You should have received a copy of the GNU General Public License along with
 * MovManager. If not, see <a
 * href="http://www.gnu.org/licenses/">http://www.gnu.org/licenses</a>.
 * </p>
 * 
 * @author	Bart Verhoeven
 * @version	0.1
 */
public interface HasMovie {

	/**
	 * Sets the given movie. When <tt>movie</tt> is null, any previous movie
	 * will be removed.
	 * 
	 * @param	movie
	 *          the movie that has to be set
	 */
	public void setMovie(Movie movie);
	
	/**
	 * Retrieves the movie.
	 * 
	 * @return	movie
	 * @throws	InvalidMovieException
	 * 			movie is invalid
	 */
	public Movie getMovie() throws InvalidMovieException;
}
